ATSUGetFontIDs

OSStatus ATSUGetFontIDs (
                     ATSUFontID oFontIDs[],
                     ItemCount iArraySize,
                     ItemCount *oFontCount);

oFontIDs

An array of values of type ATSUFontID. Before calling ATSUGetFontIDs, pass a pointer to memory that you have allocated for this array. You can determine the amount of memory to allocate by using the count returned from the function ATSUFontCount. On return, the array contains the IDs of all ATSUI-compatible fonts installed on the system.

iArraySize

The maximum number of fonts in the style object. Typically, this is equivalent to the number of IDs in the oFontIDs array. Call ATSUFontCount to determine this value.

oFontCount

A pointer to a count. On return, the actual number of ATSUI-compatible fonts that are installed on the user's system. This may be greater than the value passed in the iArraySize parameter. You cannot pass NULL for this parameter.

function result

A result code. See Result Codes.

DISCUSSION

The ATSUGetFontIDs function obtains the IDs of all ATSUI-compatible fonts that are installed on the user's system. For a description of fonts that are not compatible with ATSUI, see the discussion for ATSUFontCount. You should call ATSUGetFontIDs to rebuild your font menu when your application is brought to the foreground.

Before calling ATSUGetFontIDs, call ATSUFontCount to determine the number of ATSUI-compatible fonts installed on the user's system. You should then allocate enough memory to contain this number of fonts for the array passed back in the oFontIDs parameter.

VERSION NOTES

Available beginning with ATSUI 1.0.